gh-124668: Update asyncio doc landing page with examples
#125594
Conversation
xuantengh
requested review from
1st1,
asvetlov,
gvanrossum,
kumaraditya303 and
willingc
as code owners
|
All commit authors signed the Contributor License Agreement. |
bedevere-app
bot
added
docs
|
Preview the changed landing page: https://cpython-previews--125594.org.readthedocs.build/en/125594/library/asyncio.html |
|
|
||
| import asyncio | ||
|
|
||
| loop = asyncio.get_event_loop() |
There was a problem hiding this comment.
-1 on covering low level API and especially the fragile get_event_loop() on the landing page.
Also -1 on using create_task -- we have asyncio.TaskGroup for this.
There was a problem hiding this comment.
Hi @xuantengh, Welcome to CPython!
While I appreciate your interest in working on the issue and opening a PR, I would prefer that we keep the asyncio main page straightforward. I understand that examples can be helpful; however, I think those examples should be put within the Guides and Tutorials section.
I left some general feedback on the original issue: #124668 (comment)
This also includes a screenshot of the current doc structure for asyncio.
I'm recommending that we close this PR. If you wish to add examples to another page, please do so in a new PR. Thanks! ☀️
|
Sure, I'll add examples in corresponding pages. |
This PR aims to present
asynciocommon usages in the document landing page.📚 Documentation preview 📚: https://cpython-previews--125594.org.readthedocs.build/